docs: add AGENTS.md, CLAUDE.md, and expand README#39
Open
cziegeler wants to merge 1 commit into
Open
Conversation
Add AGENTS.md with project overview, commands, layout, dev patterns, git workflow, testing guidelines, and gotchas. Add CLAUDE.md pointing to AGENTS.md. Expand README with feature summary, baseline info, build commands, repository layout, and notes. Co-authored-by: Maia <maia@noreply>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improves onboarding and AI-agent context for the Apache Sling Scripting Core module by adding structured documentation and expanding the README.
Changes:
AGENTS.md(new): comprehensive project reference covering core commands, project layout, development patterns/constraints (Java 17, OSGi R7, Spotless, RAT), git workflow, testing guidelines (unit + Pax Exam ITs), and common gotchas.CLAUDE.md(new): thin stub that delegates toAGENTS.mdfor Claude-based AI agents.README.md: replaced the one-line description with a full overview including feature bullet list, current baseline (Java 17, OSGi R7, Sling Bundle Parent 66, dual servlet API), build/test command examples, repository layout tree, and notes on integration test behavior.Co-authored-by: Maia maia@noreply